/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ceylon.ide.eclipse.code.explorer;

import org.eclipse.jface.viewers.DecorationContext;

import org.eclipse.ui.PlatformUI;

import org.eclipse.jdt.ui.ProblemsLabelDecorator;

import org.eclipse.jdt.internal.ui.packageview.HierarchicalDecorationContext;
import org.eclipse.jdt.internal.ui.viewsupport.ColoringLabelProvider;

public class DecoratingJavaLabelProvider extends ColoringLabelProvider {

    /**
     * Decorating label provider for Java. Combines a JavaUILabelProvider
     * with problem and override indicator with the workbench decorator (label
     * decorator extension point).
     * @param labelProvider the label provider to decorate
     */
    public DecoratingJavaLabelProvider(JavaUILabelProvider labelProvider) {
        this(labelProvider, true);
    }

    /**
     * Decorating label provider for Java. Combines a JavaUILabelProvider
     * (if enabled with problem indicator) with the workbench
     * decorator (label decorator extension point).
     *     @param labelProvider the label provider to decorate
     * @param errorTick show error ticks
     */
    public DecoratingJavaLabelProvider(JavaUILabelProvider labelProvider, boolean errorTick) {
        this(labelProvider, errorTick, true);
    }

    /**
     * Decorating label provider for Java. Combines a JavaUILabelProvider
     * (if enabled with problem indicator) with the workbench
     * decorator (label decorator extension point).
     *     @param labelProvider the label provider to decorate
     * @param errorTick show error ticks
     * @param flatPackageMode configure flat package mode
     */
    public DecoratingJavaLabelProvider(JavaUILabelProvider labelProvider, boolean errorTick, boolean flatPackageMode) {
        super(labelProvider, PlatformUI.getWorkbench().getDecoratorManager().getLabelDecorator(), DecorationContext.DEFAULT_CONTEXT);
        if (errorTick) {
            labelProvider.addLabelDecorator(new ProblemsLabelDecorator(null));
        }
        setFlatPackageMode(flatPackageMode);
    }

    /**
     * Tells the label decorator if the view presents packages flat or hierarchical.
     * @param enable If set, packages are presented in flat mode.
     */
    public void setFlatPackageMode(boolean enable) {
        if (enable) {
            setDecorationContext(DecorationContext.DEFAULT_CONTEXT);
        } else {
            setDecorationContext(HierarchicalDecorationContext.getContext());
        }
    }

}
